Back to Main Menu

Get Asset, Components, and Dimensions (Assetic Python SDK)

The article Asset Tools Assetic Python SDK illustrates how to use a set of Asset Tools in the Python SDK to get an asset and it's components and dimensions using a single method.  To understand how this tool is able to consolidate these records, the following code sample works through a series of steps to build up information about the asset.

 

  1. """
  2. Get an asset including component and dimensions (Assetic.AssetsGetComplete.py)
  3. """
  4. import assetic
  5. # Assetic SDK instance
  6. asseticsdk=assetic.AsseticSDK("c:/users/you/assetic.ini",  None,"Debug")
  7. #Asset API
  8. assetapi = assetic.AssetApi()
  9. #Component API
  10. componentapi = assetic.ComponentApi()
  11. #Tool API
  12. assettools = assetic.AssetTools()
  13.   
  14. def main(assetid,attributes =  None):
  15.   """
  16.     Given an asset ID get the asset, components, and component dimensions
  17.     :param assetid: Assetic asset GUID or user friendly asset ID    
  18.     """
  19.   ##get the asset
  20.   #asset = get_asset(assetid)
  21.   if asset ==  None:
  22.   return
  23.   
  24.   #get some of the returned info
  25.     assetid = asset.get("AssetId")
  26.     assetguid = asset.get("Id")
  27.     attributes = asset.get("Attributes")
  28.     zone = attributes.get("Zone")
  29.     locality = attributes.get("Locality")
  30.   
  31.     msg =  "Asset - guid: {0}, Asset: {1}, Zone: {2}, Locality: {3}"\
  32.   .format(assetguid,assetid,zone,locality)
  33.     asseticsdk.logger.info(msg)
  34.   
  35.   ##get the components of the asset
  36.     searchfilter =  "AssetId='{0}'".format(assetid)
  37.     componentlist = get_component_list_by_filter(searchfilter)
  38.   if componentlist ==  None:
  39.   return
  40.   for row in componentlist:
  41.         msg =  "Asset has component {0}".format(row["Name"])
  42.         asseticsdk.logger.info(msg)
  43.   
  44.   ##now get a single component by ID
  45.     componentid = componentlist[0]["Id"]
  46.     component = get_component(componentid)
  47.   
  48.   #get some of the returned info
  49.   if component !=  None:
  50.         clabel = component["Label"]
  51.         ctype = component["ComponentType"]
  52.   
  53.         msg =  "Component - Label: {0}, Type: {1}".format(clabel,ctype)
  54.         asseticsdk.logger.info(msg)
  55.   
  56.   ##get dimensions
  57.     dimensions = get_dimensions(componentid)
  58.   
  59.   #get some of the returned info
  60.   if dimensions !=  None:
  61.         total = dimensions["TotalResults"]
  62.         asseticsdk.logger.info("Number of dimension records: {0}".format(total))
  63.   for dim in dimensions["ResourceList"]:
  64.             dimguid = dim["Id"]
  65.             dmeasure = dim["NetworkMeasure"]
  66.             dunit = dim["Unit"]
  67.   
  68.             msg =  "Dimension - guid: {0}, Measure: {1}, Unit: {2}".format(
  69.                 dimguid,dmeasure,dunit)
  70.             asseticsdk.logger.info(msg)
  71.   
  72. def get_asset(assetid):
  73.   """
  74.     Get an asset for the given asset ID
  75.     :param assetid: Assetic asset GUID or user friendly asset ID
  76.     :return: asset response object or None
  77.     """
  78.     asseticsdk.logger.info("Get the asset {0}".format(assetid))
  79.   #api will always return a predefined set of core fields
  80.   #define additional asset attribute fields, must define at least one
  81.   #attribute field names are the internal field names, get using metadata api
  82.     attributes = list()
  83.     attributes.append("Zone")
  84.     attributes.append("Locality")
  85.   
  86.   try:
  87.         asset = assetapi.asset_get(assetid,attributes)
  88.   except assetic.rest.ApiException  as e:
  89.   if e.status ==  404:
  90.             asseticsdk.logger.error("Asset ID {0} not found".format(assetid))
  91.   else:
  92.             asseticsdk.logger.error("Status {0}, Reason: {1} {2}".format(
  93.                 e.status,e.reason,e.body))
  94.   return  None
  95.   return asset
  96.   
  97. def get_component(componentid):
  98.   """
  99.     Get an component for the given component ID
  100.     :param componentid: Assetic component GUID or user friendly component ID
  101.     :return: component response object or None
  102.     """
  103.     asseticsdk.logger.info("Get the component {0}".format(componentid))
  104.   try:
  105.         component = componentapi.component_get(componentid)
  106.   except assetic.rest.ApiException  as e:
  107.   if e.status ==  404:
  108.             msg =  "Component for Component GUID {0} not found".format(
  109.                 componentid)
  110.             asseticsdk.logger.error(msg)
  111.   else:
  112.             msg =  "Status {0}, Reason: {1} {2}".format(e.status,e.reason,e.body)
  113.             asseticsdk.logger.error(msg)
  114.   return  None
  115.   return component
  116.   
  117. def get_component_list_by_filter(searchfilter):
  118.   """
  119.     Get an component for the given component ID 
  120.     :param searchfilter: Search filter, same format as aset search filter
  121.     :return: component array or None
  122.     """
  123.     kw =  {'request_params_page':1,
  124.   'request_params_page_size':500,
  125.   'request_params_sorts':'Name-desc',
  126.   'request_params_filters':searchfilter}
  127.     asseticsdk.logger.info("Get the components for search filter {0}".format(
  128.         searchfilter))
  129.   try:
  130.         component = componentapi.component_get_0(**kw)
  131.   except assetic.rest.ApiException  as e:
  132.         msg =  "Status {0}, Reason: {1} {2}".format(e.status,e.reason,e.body)
  133.         asseticsdk.logger.error(msg)
  134.   return  None
  135.   if component["TotalResults"]  >  0:
  136.   return component["ResourceList"]
  137.   else:
  138.   return  None
  139.   
  140. def get_dimensions(componentid):
  141.   """
  142.     Get an dimension array for the given component ID
  143.     :param componentid: Assetic component GUID or user friendly component ID
  144.     :return: dimension response object or None
  145.     """
  146.     asseticsdk.logger.info("Get the dimensions for component {0}".format(
  147.         componentid))
  148.   try:
  149.         dimensions = componentapi.component_get_dimension(componentid)
  150.   except assetic.rest.ApiException  as e:
  151.   if e.status ==  404:
  152.             msg =  "Dimensions for Component {0} not found".format(assetguid)
  153.             asseticsdk.logger.error(msg)
  154.   else:
  155.             msg =  "Status {0}, Reason: {1} {2}".format(e.status,e.reason,e.body)
  156.             asseticsdk.logger.error(msg)
  157.   return  None
  158.   return dimensions
  159.   
  160. ##This will run the method main() to kickstart it all
  161. if __name__ ==  "__main__":
  162.     assetid =  "411142055"
  163.     main(assetid,["Zone","Comment"])